getScheduleHistory

Returns a list of song play histories matching a time range and library query.

Sample Request

<mmRequest command="getScheduleHistory" station="ID" [version="1"] [client=""] [userData=""]>
	<contents>
		<startTime>yyyy-mm-ddThh:00:00</startTime>
		<endTime> yyyy-mm-ddThh:00:00</endTime>
		<query>
			[<categories>
				<category [id="1"] [code="A"]/>
			</categories>]
			[<filters>
				<filter [type="fieldId|fieldName"] target="Artist" operator="contains" value="love"/>
			</filters>]
			[<sortKeys>
				<sortKey [type="fieldId|fieldName"] target="Artist" order="asc|desc"/>
			</sortKeys>]
			[<properties>
				<property name="propname">value</property>
			</properties>]
		</query>
	</contents>
</mmRequest>

Request Notes

startTime – The first hour to include in the reply. This is the first full hour that will be included.

 

endTime – The last hour to include in the reply. This is the last full hour that will be included.

 

query - The actual search request is provided in the contents/query section. All sections and tags are optional. You only need to include the portions necessary to define the desired search query. See Appendix B - Nexus Library Query Tags for complete details of the Nexus query tags.

 

Note: For this function, the sortKeys portion of the query does not have any effect.

 

Note:  This command will include archive history if any of the specified time range is in the archived history time period.

Sample Reply

<mmReply command="getScheduleHistory" station="ID" version="1" [userData=""] status="???????">
	<contents>
		<historyList>
			<history songId="999" categoryId="1" airdate="yyyy-mm-dd" airTime="hh:mm:ss" runtime="mm:ss" />
		</historyList>
	</contents>
</mmReply>

Compatibility and Version Info

Available with MusicMaster PRO 4.0sr20 and later